home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / lib / c / etc / RCS / Misc_InvokeEditor.man,v < prev    next >
Text File  |  1991-06-04  |  2KB  |  70 lines
  1. head     1.1;
  2. branch   ;
  3. access   ;
  4. symbols  ;
  5. locks    ; strict;
  6. comment  @@;
  7.  
  8.  
  9. 1.1
  10. date     91.06.04.16.32.02;  author kupfer;  state Exp;
  11. branches ;
  12. next     ;
  13.  
  14.  
  15. desc
  16. @Manual page for the Misc_InvokeEditor function.
  17. @
  18.  
  19.  
  20.  
  21. 1.1
  22. log
  23. @Initial revision
  24. @
  25. text
  26. @'\" Copyright 1991 Regents of the University of California
  27. '\" Permission to use, copy, modify, and distribute this
  28. '\" documentation for any purpose and without fee is hereby
  29. '\" granted, provided that this notice appears in all copies.
  30. '\" The University of California makes no representations about
  31. '\" the suitability of this material for any purpose.  It is
  32. '\" provided "as is" without express or implied warranty.
  33. '\" 
  34. '\" $Header: /sprite/lib/forms/RCS/lib.man,v 1.3 91/01/07 17:55:52 mottsmth Exp $ SPRITE (Berkeley)
  35. '/" 
  36. .so \*(]ltmac.sprite
  37. .HS Misc lib
  38. .BS
  39. '\" Note:  do not modify the .SH NAME line immediately below!
  40. .SH NAME
  41. Misc_InvokeEditor \- Invoke an editor for a user
  42. .SH SYNOPSIS
  43. .nf
  44. \fB#include <libc.h>\fR
  45. .sp
  46. int
  47. \fBMisc_InvokeEditor\fR(\fIfile\fP)
  48. .SH ARGUMENTS
  49. .AS char *file
  50. .AP char *file in
  51. Name of the file to edit.
  52. .BE
  53.  
  54. .SH DESCRIPTION
  55. .PP
  56. If a program needs to have the user edit a file, it can simply call 
  57. .B Misc_InvokeEditor
  58. with the name of the file to edit.  The user's editor (as defined by
  59. the EDITOR environment variable, with
  60. .B vi
  61. being the default) will be invoked.  
  62. .B Misc_InvokeEditor
  63. returns the exit status from the editor.  For setuid and setgid
  64. programs, the editor is invoked with the user's real (not effective)
  65. user and group IDs.
  66.  
  67. .SH KEYWORDS
  68. edit, file
  69. @
  70.